HDDS-4076. Translate CSI.md into Chinese by maobaolong · Pull Request #1299 · apache/ozone

maobaolong · 2020-08-07T04:52:14Z

What changes were proposed in this pull request?

Translate CSI.md into Chinese

What is the link to the Apache JIRA

HDDS-4076

How was this patch tested?

No need

cxorm

Thanks @maobaolong for the translation work.
Overall looks good, some suggestions are added inline.

hadoop-hdds/docs/content/interface/CSI.zh.md

cxorm · 2020-08-07T10:00:31Z

hadoop-hdds/docs/content/interface/CSI.zh.md

+首先，我们需要一个带有S3Gateway的Ozone集群，并且它的OM和S3Gateway的端口都可以对CSI pod可见，
+因为CSIServer 将会访问 OM 来创建或者删除篮子，并且，CSIServer将会通过goofys创建到s3g的挂载点的方式来发布桶。 
+
+如果你没有一个运行在kubernetes上的Ozone集群，你可以参考[Kubernetes]({{< ref "start/Kubernetes.zh.md" >}}) 来创建一个。


Suggested change

如果你没有一个运行在kubernetes上的Ozone集群，你可以参考[Kubernetes]({{< ref "start/Kubernetes.zh.md" >}}) 来创建一个。

如果你没有一个运行在kubernetes上的Ozone集群，你可以参考[Kubernetes](https://github.com/apache/hadoop-ozone/blob/master/hadoop-hdds/docs/content/start/Kubernetes.zh.md) 来创建一个。

@cxorm I don't think we should hard-code URLs like that. What's the problem with the Hugo ref shortcode?

Thank you @adoroszlai for the reminder.

Yeah the URL here could be not hard-code by Hugo. (I just show it in other .md editor and not consider Hugo)

No problem here.

@cxorm https://ci-hadoop.apache.org/view/Hadoop%20Ozone/job/ozone-doc-master/lastSuccessfulBuild/artifact/hadoop-hdds/docs/public/interface/csi.html

This is the English version of CSI.md, I don't catch the point why you suggest me to change [Kubernetes]({{< ref "start/Kubernetes.zh.md" >}}) into (https://github.com/apache/hadoop-ozone/blob/master/hadoop-hdds/docs/content/start/Kubernetes.zh.md), I think it can works like my origin way, If there are something wrong with me, please correct me.

Thank you @maobaolong for the reply.
No problem here, it's my carelessness.

hadoop-hdds/docs/content/interface/CSI.zh.md

adoroszlai · 2020-08-07T10:20:28Z

How was this patch tested?

No need

Although this is only a documentation change, I don't agree that tests can be skipped. Some ideas for testing:

Use mvn -pl :hadoop-hdds-docs clean package to generate static docs. It should succeed without errors. Compile errors may be caused eg. by invalid syntax.
Open the generated page in a browser and
- check that layout is fine (compare to English version),
- check that there are no broken images (compare to English version),
- verify all links work.

Hope that helps.

Co-authored-by: Yi-Sheng Lien <[email protected]>

maobaolong · 2020-08-07T13:29:35Z

@adoroszlai Thanks for tell me how to test the docs changes locally.

It works good, the link can works also.

PTAL.

codecov-commenter · 2020-08-07T14:20:06Z

Codecov Report

Merging #1299 into master will decrease coverage by 0.11%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master    #1299      +/-   ##
============================================
- Coverage     74.55%   74.43%   -0.12%     
+ Complexity    10280    10260      -20     
============================================
  Files           979      979              
  Lines         50282    50282              
  Branches       4909     4909              
============================================
- Hits          37488    37428      -60     
- Misses        10452    10494      +42     
- Partials       2342     2360      +18

Impacted Files	Coverage Δ	Complexity Δ
...doop/ozone/om/exceptions/OMNotLeaderException.java	`48.48% <0.00%> (-18.19%)`	`3.00% <0.00%> (-2.00%)`
...e/hadoop/ozone/recon/tasks/OMUpdateEventBatch.java	`75.00% <0.00%> (-8.34%)`	`6.00% <0.00%> (-1.00%)`
...ozone/container/ozoneimpl/ContainerController.java	`81.57% <0.00%> (-5.27%)`	`14.00% <0.00%> (-1.00%)`
.../apache/hadoop/ozone/protocolPB/OzonePBHelper.java	`90.00% <0.00%> (-5.00%)`	`6.00% <0.00%> (-1.00%)`
...op/ozone/container/common/impl/HddsDispatcher.java	`74.81% <0.00%> (-4.45%)`	`76.00% <0.00%> (-3.00%)`
...e/commandhandler/CreatePipelineCommandHandler.java	`87.50% <0.00%> (-4.17%)`	`8.00% <0.00%> (ø%)`
...e/commandhandler/CloseContainerCommandHandler.java	`82.45% <0.00%> (-3.51%)`	`11.00% <0.00%> (ø%)`
...iner/common/transport/server/ratis/CSMMetrics.java	`73.84% <0.00%> (-3.08%)`	`21.00% <0.00%> (-1.00%)`
.../apache/hadoop/hdds/scm/node/NodeStateManager.java	`75.00% <0.00%> (-3.05%)`	`42.00% <0.00%> (-1.00%)`
...ent/algorithms/SCMContainerPlacementRackAware.java	`76.69% <0.00%> (-3.01%)`	`31.00% <0.00%> (-2.00%)`
... and 11 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d7ea496...0762080. Read the comment docs.

runitao · 2020-08-07T18:09:01Z

hadoop-hdds/docs/content/interface/CSI.zh.md

+
+容器存储接口 `Container Storage Interface` (CSI) 使存储供应商（SP）能够一次性开发一个插件，并让它跨多个容器编排工作。
+
+获取更多CSI的信息，可以参考[SCI spec](https://github.com/container-storage-interface/spec/blob/master/spec.md)


How about add one space before/after the English words? Like that 多CSI的 -> 多 CSI 的.
Would you please to keep above style consistent in the whole article?

Thanks @runitao for your suggestion, it make this document much pretty. Now, i addressed your comment, PTAL.

runitao · 2020-08-08T00:45:14Z

hadoop-hdds/docs/content/interface/CSI.zh.md

+---
+title: CSI 协议
+weight: 3
+summary: Ozone 支持 容器存储接口(CSI) 协议。你可以通过Ozone CSI 挂载 Ozone 桶的方式使用 Ozone。


接口(CSI) 协 -> 接口 (CSI) 协
通过Ozone CSI 挂 -> 通过 Ozone CSI 挂

runitao · 2020-08-08T00:48:47Z

hadoop-hdds/docs/content/interface/CSI.zh.md

+
+## 入门
+
+首先，我们需要一个带有 S3Gateway 的 Ozone 集群，并且它的 OM 和 S3Gateway 的端口都可以对 CSI pod 可见，


In the original English doc, the s3gateway is used.

Done. I should keep consistent with the English version, thanks, I've corrected it.

runitao · 2020-08-08T00:50:53Z

hadoop-hdds/docs/content/interface/CSI.zh.md

+## 入门
+
+首先，我们需要一个带有 S3Gateway 的 Ozone 集群，并且它的 OM 和 S3Gateway 的端口都可以对 CSI pod 可见，
+因为 CSIServer 将会访问 OM 来创建或者删除篮子，并且，CSIServer 将会通过 goofys 创建到 s3g 的挂载点的方式来发布桶。 


bucket shoud be translated to 桶
I think also, CSIServer will publish volume by creating a mount point to s3g through goofys. shoud be translate to 同时 CSIServer 通过 goofys 创建一个可以访问 s3g 的挂载点来发布卷。

runitao · 2020-08-08T00:59:10Z

hadoop-hdds/docs/content/interface/CSI.zh.md

+
+如果你没有一个运行在 kubernetes 上的 Ozone 集群，你可以参考[Kubernetes]({{< ref "start/Kubernetes.zh.md" >}}) 来创建一个。
+使用来自 `kubernetes/examples/ozone`的资源，你可以找到所有需要的kubernetes资源来和指定的CSI运行在一起
+(参考 `kubernetes/examples/ozone/csi`)   


miss spaces around kubernetes and CSI. kubernetes资源来和指定的CSI运行

I think we shoud use K in Kubernetes, although kubernetes is sometimes used in original doc.

Done. Thanks for point it for me.

runitao · 2020-08-08T01:04:59Z

hadoop-hdds/docs/content/interface/CSI.zh.md

+kubectl create -f /ozone/kubernetes/examples/ozone/pv-test
+```
+
+连接 pod scm-0 并且 创建一个键到桶 /s3v/pvc* 。


并在 /s3v/pvc* 桶中创建一个键值。

runitao · 2020-08-08T01:14:15Z

hadoop-hdds/docs/content/interface/CSI.zh.md

+[hadoop@scm-0 ~]$ ozone sh key put /s3v/pvc-861e2d8b-2232-4cd1-b43c-c0c26697ab6b/A LICENSE.txt
+```
+
+现在，通过映射 `ozone-csi-test-webserver-7cbdc5d65c-h5mnn` 的端口来通过浏览器看到 web 页面.


端口来通过浏览器看到 web 页面. -> 端口，我们可以使用浏览器展示其 UI 页面。

runitao

I comment inline, @maobaolong could you please to check them?

maobaolong · 2020-08-09T01:54:36Z

@runitao Thanks advance for correct me so much translate issue, please take another look at the @runitao Thanks advance for correct me so much translate issue, please take another look at this PR.

runitao

+1 LGTM

maobaolong · 2020-08-10T04:53:43Z

@runitao Thanks for you review and improve my Chinese 😄
@cxorm @adoroszlai Thanks for the previous review, PTAL.

cxorm · 2020-08-10T06:54:11Z

LGTM. +1.
Thanks @runitao for the review, I think we could add some rules about translation on jira or wiki (such as "one space before/after the English words"), and anyone could refer the rules when contributing translation work.

maobaolong · 2020-08-11T08:10:17Z

@cxorm Something like this

adoroszlai · 2020-08-11T08:18:47Z

Thanks @maobaolong for the translation, and @cxorm and @runitao for the review.

* master: (28 commits) HDDS-4037. Incorrect container numberOfKeys and usedBytes in SCM after key deletion (apache#1295) HDDS-3232. Include the byteman scripts in the distribution tar file (apache#1309) HDDS-4095. Byteman script to debug HCFS performance (apache#1311) HDDS-4057. Failed acceptance test missing from bundle (apache#1283) HDDS-4040. [OFS] BasicRootedOzoneFileSystem to support batchDelete (apache#1286) HDDS-4061. Pending delete blocks are not always included in #BLOCKCOUNT metadata (apache#1288) HDDS-4067. Implement toString for OMTransactionInfo (apache#1300) HDDS-3878. Make OMHA serviceID optional if one (but only one) is defined in the config (apache#1149) HDDS-3833. Use Pipeline choose policy to choose pipeline from exist pipeline list (apache#1096) HDDS-3979. Make bufferSize configurable for stream copy (apache#1212) HDDS-4048. Show more information while SCM version info mismatch (apache#1278) HDDS-4078. Use HDDS InterfaceAudience/Stability annotations (apache#1302) HDDS-4034. Add Unit Test for HadoopNestedDirGenerator. (apache#1266) HDDS-4076. Translate CSI.md into Chinese (apache#1299) HDDS-4046. Extensible subcommands for CLI applications (apache#1276) HDDS-4051. Remove whitelist/blacklist terminology from Ozone (apache#1306) HDDS-4055. Cleanup GitHub workflow (apache#1282) HDDS-4042. Update documentation for the GA release (apache#1269) HDDS-4066. Add core-site.xml to intellij configuration (apache#1292) HDDS-4073. Remove leftover robot.robot (apache#1297) ...

maobaolong added 2 commits August 7, 2020 12:48

HDDS-4076. Translate CSI.md into Chinese

9a4ba2d

fix bad link

547c75e

cxorm reviewed Aug 7, 2020

View reviewed changes

hadoop-hdds/docs/content/interface/CSI.zh.md Outdated Show resolved Hide resolved

adoroszlai added the documentation Improvements or additions to documentation label Aug 7, 2020

maobaolong closed this Aug 7, 2020

maobaolong reopened this Aug 7, 2020

maobaolong and others added 2 commits August 7, 2020 21:08

Update hadoop-hdds/docs/content/interface/CSI.zh.md

9575413

Co-authored-by: Yi-Sheng Lien <[email protected]>

Update hadoop-hdds/docs/content/interface/CSI.zh.md

0762080

Co-authored-by: Yi-Sheng Lien <[email protected]>

runitao reviewed Aug 7, 2020

View reviewed changes

add one space before/after the English words

c586124

runitao reviewed Aug 8, 2020

View reviewed changes

runitao suggested changes Aug 8, 2020

View reviewed changes

Improve the translation and address comment suggestions.

c12326c

maobaolong closed this Aug 9, 2020

maobaolong reopened this Aug 9, 2020

runitao approved these changes Aug 10, 2020

View reviewed changes

maobaolong requested a review from adoroszlai August 11, 2020 08:10

adoroszlai merged commit 43471f7 into apache:master Aug 11, 2020

maobaolong mentioned this pull request Aug 12, 2020

HDDS-4111. Keep the CSI.zh.md consistent with CSI.md #1320

Merged

rakeshadr pushed a commit to rakeshadr/hadoop-ozone that referenced this pull request Sep 3, 2020

HDDS-4076. Translate CSI.md into Chinese (apache#1299)

f3a17c8

	如果你没有一个运行在kubernetes上的Ozone集群，你可以参考[Kubernetes]({{< ref "start/Kubernetes.zh.md" >}}) 来创建一个。
	如果你没有一个运行在kubernetes上的Ozone集群，你可以参考[Kubernetes](https://github.com/apache/hadoop-ozone/blob/master/hadoop-hdds/docs/content/start/Kubernetes.zh.md) 来创建一个。


		容器存储接口 `Container Storage Interface` (CSI) 使存储供应商（SP）能够一次性开发一个插件，并让它跨多个容器编排工作。

		获取更多CSI的信息，可以参考[SCI spec](https://github.com/container-storage-interface/spec/blob/master/spec.md)


		## 入门

		首先，我们需要一个带有 S3Gateway 的 Ozone 集群，并且它的 OM 和 S3Gateway 的端口都可以对 CSI pod 可见，

Conversation

maobaolong commented Aug 7, 2020

What changes were proposed in this pull request?

What is the link to the Apache JIRA

How was this patch tested?

Uh oh!

cxorm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maobaolong Aug 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adoroszlai commented Aug 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How was this patch tested?

Uh oh!

maobaolong commented Aug 7, 2020

Uh oh!

codecov-commenter commented Aug 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

runitao Aug 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

runitao Aug 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

runitao Aug 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

runitao Aug 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

runitao left a comment

Choose a reason for hiding this comment

Uh oh!

maobaolong commented Aug 9, 2020

Uh oh!

runitao left a comment

Choose a reason for hiding this comment

Uh oh!

maobaolong commented Aug 10, 2020

Uh oh!

cxorm commented Aug 10, 2020

maobaolong Aug 7, 2020 •

edited

Loading

adoroszlai commented Aug 7, 2020 •

edited

Loading

codecov-commenter commented Aug 7, 2020 •

edited

Loading

runitao Aug 7, 2020 •

edited

Loading

runitao Aug 8, 2020 •

edited

Loading

runitao Aug 8, 2020 •

edited

Loading

runitao Aug 8, 2020 •

edited

Loading